/*
 * Copyright 2007-2008 Sun Microsystems, Inc.  All Rights Reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * This code is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 only, as
 * published by the Free Software Foundation.  Sun designates this
 * particular file as subject to the "Classpath" exception as provided
 * by Sun in the LICENSE file that accompanied this code.
 *
 * This code is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 * version 2 for more details (a copy is included in the LICENSE file that
 * accompanied this code).
 *
 * You should have received a copy of the GNU General Public License version
 * 2 along with this work; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
 * CA 95054 USA or visit www.sun.com if you need additional information or
 * have any questions.
 */

package jsr203.nio.file.attribute;

import java.io.IOException;
import java.util.concurrent.TimeUnit;
import jsr203.nio.file.FileRef;

/**
 * A file attribute view that provides a view of a <em>basic set</em> of file
 * attributes common to many file systems. The basic set of file attributes
 * consist of <em>mandatory</em> and <em>optional</em> file attributes as
 * defined by the {@link BasicFileAttributes} interface.
 *
 * <p> The file attributes are retrieved from the file system as a <em>bulk
 * operation</em> by invoking the {@link #readAttributes() readAttributes} method.
 * This class also defines the {@link #setTimes setTimes} method to update the
 * file's time attributes.
 *
 * @since 1.7
 */

public interface BasicFileAttributeView
    extends FileAttributeView
{
    @Override
    BasicFileAttributeView bind(FileRef file);

    @Override
    BasicFileAttributeView bind(FileRef file, boolean followLinks);

    /**
     * Reads the file attributes as a bulk operation.
     *
     * <p> It is implementation specific if all file attributes are read as an
     * atomic operation with respect to other file system operations.
     *
     * @return  The file attributes
     *
     * @throws  IllegalStateException
     *          If the attribute view is not bound, or if bound to an object
     *          that is not open for reading
     * @throws  IOException
     *          If an I/O error occurs
     * @throws  SecurityException
     *          In the case of the default provider, a security manager is
     *          installed, its {@link SecurityManager#checkRead(String) checkRead}
     *          method is invoked to check read access to the file
     */
    BasicFileAttributes readAttributes() throws IOException;

    /**
     * Updates any or all of the file's last modified time, last access time,
     * and create time attributes.
     *
     * <p> This method updates the file's timestamp attributes. The values are
     * measured since the epoch (00:00:00 GMT, January 1, 1970) and converted to
     * the precision supported by the file system. Converting from finer to
     * coarser granularities result in precision loss. This method may not be
     * used to update the attribute to a time that precedes the epoch.
     *
     * <p> If any of the {@code lastModifiedTime}, {@code lastAccessTime},
     * or {@code createTime} parameters has the value {@code null} then the
     * corresponding attribute is not changed. An implementation may require to
     * read the existing values of the file attributes when only some, but not
     * all, of the timestamp attributes are updated. Consequently, this method
     * may not be an atomic operation with respect to other file system
     * operations. If all of the {@code lastModifiedTime}, {@code
     * lastAccessTime} and {@code createTime} parameters are {@code null} then
     * this time has no effect and the value of the {@code unit} parameter is
     * ignored. The value of the {@code unit} parameter is also ignored if
     * all parameters have the value {@code null}. As the {@code lastAccessTime}
     * and {@code createTime} are optional file attributes then their values
     * may be ignored by implementations that do not support these attributes.
     *
     * @param   lastModifiedTime
     *          The new last modified time, or {@code -1L} to update it to
     *          the current time, or {@code null} to not change the attribute
     * @param   lastAccessTime
     *          The last access time, or {@code -1L} to update it to
     *          the current time, or {@code null} to not change the attribute.
     * @param   createTime
     *          The file's create time, or {@code -1L} to update it to
     *          the current time, or {@code null} to not change the attribute
     * @param   unit
     *          A {@code TimeUnit} determining how to interpret the time values
     *
     * @return  this attribute view
     *
     * @throws  UnsupportedOperationException
     *          If not following links, the file is a link, and the implementation
     *          does not support updating the attributes of a symbolic link
     * @throws  IllegalArgumentException
     *          If any of the parameters is a negative value other than {@code
     *          -1L}
     * @throws  IllegalStateException
     *          If the attribute view is not bound, or if bound to an object
     *          that is not open for writing
     * @throws  IOException
     *          If an I/O error occurs
     * @throws  SecurityException
     *          In the case of the default provider, a security manager is
     *          installed, its  {@link SecurityManager#checkWrite(String) checkWrite}
     *          method is invoked to check write access to the file
     */
    BasicFileAttributeView setTimes(Long lastModifiedTime,
                                    Long lastAccessTime,
                                    Long createTime,
                                    TimeUnit unit) throws IOException;
}
